← Tilbage til Hovedside

Overblik

Dette afsnit beskriver de tilgængelige REST-endpoints til søgning efter fast ejendom.

Generelt er svar på søgninger formateret i JSON. De fundne objekter vil typisk være identificeret ved et UUID, som efterfølgende kan bruges ved opslag via ejdsummarisk-endpointet.

Endpoints

Søgning med adresse

Endpoint URL: ejendom/adresse

Method

GET

Beskrivelse

Søgning efter fast ejendom ved hjælp af adresseoplysninger. Der kan søges med eller uden etage og side/dør.

Input

Query parametre (alle valgfrie):

  • husnummer

  • postnummer

  • vejnavn

  • etage

  • sidedoer

  • by

Content-Type

Kræver application/json for både anmodning og svar.

Output

JSON-svar indeholdende en liste af matchende ejendomme (inkl. uuid).

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /ejendom/adresse?postnummer=4040&vejnavn=Venusvej&husnummer=1&etage=&sidedoer=&by=Jyllinge HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

Søgning med Bestemt Fast Ejendomsnummer (BFE-nr.)

Endpoint URL: ejendom/hovednoteringsnummer

Method

GET

Beskrivelse

Søgning efter fast ejendom ved hjælp af hovednoteringsnummer (BFE-nr.).

Input

Query parameter (påkrævet):

  • hovednoteringsnummer

Output

JSON-svar indeholdende den matchende ejendom.

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /ejendom/hovednoteringsnummer?hovednoteringsnummer=2220333 HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

Søgning efter umatrikuleret areal

Endpoint URL: ejendom/uma/{uma}

Method

GET

Beskrivelse

Søgning efter fast ejendom via et umatrikuleret areal (UMA) identifikator.

Input

Path parameter (påkrævet):

  • uma

Output

JSON-svar indeholdende den matchende ejendom.

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /ejendom/uma/21 HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

Søgning med landsejerlav og matrikelnummer

Endpoint URL: ejendom/landsejerlavmatrikel

Method

GET

Beskrivelse

Søgning efter fast ejendom ved at angive landsejerlav-ID (landsejerlavid) og matrikelnummer (matrikelnr).

Input

Query parametre (påkrævet):

  • landsejerlavid

  • matrikelnr

Output

JSON-svar indeholdende den matchende ejendom.

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /ejendom/landsejerlavmatrikel?landsejerlavid=760353&matrikelnr=0039ac HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

EjendomSummarisk

Endpoint URL: ejdsummarisk/{uuid}

Method

GET

Beskrivelse

Hent omfattende ejendomssammendragsoplysninger ved hjælp af ejendommens UUID. Svarformatet kan styres via valgfrie query parametre.

Input

Path parameter:

  • uuid

Valgfrie query parametre:

  • xhtml=true - returnerer svaret som XHTML

  • tmvXhtml=true - returnerer svaret som TMV XHTML

  • Hvis ingen angives, returneres som OIO XML (standard)

Output

Ejendomssammendragsdata i det ønskede format (OIO XML, XHTML eller TMV XHTML).

Formateringen af XHTML- og TMV XHTML-svar er ikke dokumenteret i detaljer og kan ændres uden varsel.

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /ejendomsummarisk/cda5fd18-7366-4613-9395-f42f3c441389?xhtml=false&tmvxhtml=false HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

HistoriskAdkomst

Endpoint URL: ejdhistoriskadkomst/uuid/{uuid}

Method

GET

Beskrivelse

Hent historiske adkomstoplysninger for en ejendom ved hjælp af dens UUID.

Input

Path parameter:

  • uuid

Output

JSON-svar indeholdende historiske adkomstoplysninger for ejendommen.

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /ejdhistoriskadkomst/uuid/ba7eb3f4-18ba-43cd-b442-e791248e0a13 HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*